<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>Paho C++: mqtt::callback Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="pahologo.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">Paho C++
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">The Paho MQTT C++ Client Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classmqtt_1_1callback.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Friends</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classmqtt_1_1callback-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">mqtt::callback Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Provides a mechanism for tracking the completion of an asynchronous action.  
 <a href="classmqtt_1_1callback.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="callback_8h_source.html">callback.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for mqtt::callback:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classmqtt_1_1callback.png" usemap="#mqtt::callback_map" alt=""/>
  <map id="mqtt::callback_map" name="mqtt::callback_map">
<area href="classmqtt_1_1client.html" title="Lightweight client for talking to an MQTT server using methods that block until an operation complete..." alt="mqtt::client" shape="rect" coords="0,56,86,80"/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a40562ff84237a6935d804c3bf47a6a66"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a40562ff84237a6935d804c3bf47a6a66"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a40562ff84237a6935d804c3bf47a6a66">ptr_t</a> = std::shared_ptr&lt; <a class="el" href="classmqtt_1_1callback.html">callback</a> &gt;</td></tr>
<tr class="memdesc:a40562ff84237a6935d804c3bf47a6a66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to an object of this type. <br/></td></tr>
<tr class="separator:a40562ff84237a6935d804c3bf47a6a66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18487d400efd4b64c9e29261a42b79fe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18487d400efd4b64c9e29261a42b79fe"></a>
using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a18487d400efd4b64c9e29261a42b79fe">const_ptr_t</a> = std::shared_ptr&lt; const <a class="el" href="classmqtt_1_1callback.html">callback</a> &gt;</td></tr>
<tr class="memdesc:a18487d400efd4b64c9e29261a42b79fe"><td class="mdescLeft">&#160;</td><td class="mdescRight">Smart/shared pointer to a const object of this type. <br/></td></tr>
<tr class="separator:a18487d400efd4b64c9e29261a42b79fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a55f55da1b60e5f0d0f87e45dbe8538ff"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a55f55da1b60e5f0d0f87e45dbe8538ff"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a55f55da1b60e5f0d0f87e45dbe8538ff">~callback</a> ()</td></tr>
<tr class="memdesc:a55f55da1b60e5f0d0f87e45dbe8538ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Virtual destructor. <br/></td></tr>
<tr class="separator:a55f55da1b60e5f0d0f87e45dbe8538ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a831d2270e3296527fce29852c2822c86"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a831d2270e3296527fce29852c2822c86">connected</a> (const string &amp;cause)</td></tr>
<tr class="memdesc:a831d2270e3296527fce29852c2822c86"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when the client is connected.  <a href="#a831d2270e3296527fce29852c2822c86">More...</a><br/></td></tr>
<tr class="separator:a831d2270e3296527fce29852c2822c86"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad33f388261c80db6d529089a9561c69d"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#ad33f388261c80db6d529089a9561c69d">connection_lost</a> (const string &amp;cause)</td></tr>
<tr class="memdesc:ad33f388261c80db6d529089a9561c69d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when the connection to the server is lost.  <a href="#ad33f388261c80db6d529089a9561c69d">More...</a><br/></td></tr>
<tr class="separator:ad33f388261c80db6d529089a9561c69d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae18e49acbf085b2e419d43916a5150c8"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#ae18e49acbf085b2e419d43916a5150c8">message_arrived</a> (const_message_ptr msg)</td></tr>
<tr class="memdesc:ae18e49acbf085b2e419d43916a5150c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">This method is called when a message arrives from the server.  <a href="#ae18e49acbf085b2e419d43916a5150c8">More...</a><br/></td></tr>
<tr class="separator:ae18e49acbf085b2e419d43916a5150c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7165d51b17104475f679254d25b4ba97"><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classmqtt_1_1callback.html#a7165d51b17104475f679254d25b4ba97">delivery_complete</a> (delivery_token_ptr tok)</td></tr>
<tr class="memdesc:a7165d51b17104475f679254d25b4ba97"><td class="mdescLeft">&#160;</td><td class="mdescRight">Called when delivery for a message has been completed, and all acknowledgments have been received.  <a href="#a7165d51b17104475f679254d25b4ba97">More...</a><br/></td></tr>
<tr class="separator:a7165d51b17104475f679254d25b4ba97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Provides a mechanism for tracking the completion of an asynchronous action. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a831d2270e3296527fce29852c2822c86"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void mqtt::callback::connected </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>cause</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called when the client is connected. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cause</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ad33f388261c80db6d529089a9561c69d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void mqtt::callback::connection_lost </td>
          <td>(</td>
          <td class="paramtype">const string &amp;&#160;</td>
          <td class="paramname"><em>cause</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called when the connection to the server is lost. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cause</td><td></td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a7165d51b17104475f679254d25b4ba97"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void mqtt::callback::delivery_complete </td>
          <td>(</td>
          <td class="paramtype">delivery_token_ptr&#160;</td>
          <td class="paramname"><em>tok</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Called when delivery for a message has been completed, and all acknowledgments have been received. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">tok</td><td>The token tracking the message delivery. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="ae18e49acbf085b2e419d43916a5150c8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual void mqtt::callback::message_arrived </td>
          <td>(</td>
          <td class="paramtype">const_message_ptr&#160;</td>
          <td class="paramname"><em>msg</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>This method is called when a message arrives from the server. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">msg</td><td>The message </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/mqtt/<a class="el" href="callback_8h_source.html">callback.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>mqtt</b></li><li class="navelem"><a class="el" href="classmqtt_1_1callback.html">callback</a></li>
    <li class="footer">Generated on Sun Jul 23 2017 10:24:29 for Paho C++ by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 </li>
  </ul>
</div>
</body>
</html>
